Name the two parameters BitFieldsToString actually takes - #553
Open
karpovantonme wants to merge 1 commit into
Open
Name the two parameters BitFieldsToString actually takes#553karpovantonme wants to merge 1 commit into
karpovantonme wants to merge 1 commit into
Conversation
The @PARAM line was copied from BitFieldToString above it and still names a single field. BitFieldsToString takes bits and count, so Doxygen drops the entry and both parameters render undocumented. clang -Wdocumentation on bitset_utils.hpp: one warning before, none after. Human manager: @karpovantonme Docstring drafted with Claude Opus, per doc/dev/ai-usage-guidelines.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
BitFieldsToString(bits_field_t * bits, size_t count)documents a parameter calledfield, which the function does not take, and says nothing about the two it does.Doxygen drops an unknown
@paramand leaves the real ones undocumented, so the rendered page for this function has no parameter list at all.